home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1996 October: Mac OS SDK / Dev.CD Oct 96 SDK / Dev.CD Oct 96 SDK2.toast / Development Kits (Disc 2) / OpenDoc Development Framework / ODFDev / ODF / OS / FWResour / Include / FWResFil.h < prev    next >
Encoding:
Text File  |  1996-08-16  |  3.2 KB  |  110 lines  |  [TEXT/MPS ]
  1. //========================================================================================
  2. //
  3. //    File:                FWResFil.h
  4. //    Release Version:    $ ODF 1 $
  5. //
  6. //    Copyright:    (c) 1993 - 1996 by Apple Computer, Inc., all rights reserved.
  7. //
  8. //========================================================================================
  9.  
  10. #if !defined(FWRESFIL_H) && !defined(__ODFRC__)
  11. #define FWRESFIL_H
  12.  
  13. #ifndef FWSOMPTR_H
  14. #include "FWSOMPtr.h"
  15. #endif
  16.  
  17. #ifndef FWEXCDEF_H
  18. #include "FWExcDef.h"
  19. #endif
  20.  
  21. #ifndef FWCOUPTR_H
  22. #include "FWCouPtr.h"
  23. #endif
  24.  
  25. #include "SLResFil.xh"
  26.  
  27. //========================================================================================
  28. // CLASS FW_PResourceFile
  29. //
  30. //        Inherited API for operator->()
  31. //
  32. //            FW_OFileSpecification GetFileSpecification();
  33. //                // Get the file specification for the resourcesFile.
  34. //        
  35. //            FW_Boolean HasResource(in FW_ResourceId resourceId,
  36. //                                   in FW_ResourceType resourceType);
  37. //                // Returns TRUE if the resource exists in the file, FALSE if it doesn't.
  38. //    
  39. //            FW_ResourceHandle GetResourceHandle(in FW_ResourceId resourceId,
  40. //                                                in FW_ResourceType resourceType);
  41. //                // Gets the resource handle.  Resource data may still be purgeable or unloaded.
  42. //                // Client assumes responsibility to call ReleaseResourceHandle when done.
  43. //    
  44. //            void ReleaseResourceHandle(in FW_ResourceHandle handle);
  45. //                // Releases the resource handle.  All memory is released.
  46. //    
  47. //========================================================================================
  48.  
  49. class FW_PResourceFile : public FW_TCountedSOMPtr<FW_OResourceFile>
  50. {
  51. public:
  52.  
  53.     FW_DECLARE_AUTO(FW_PResourceFile)
  54.  
  55.     FW_PResourceFile(Environment* ev, FW_OResourceFile *rep);
  56.         // Attach to the given resources file rep.
  57.  
  58.     FW_PResourceFile(Environment* ev, FW_OFileSpecification* newFileSpec);
  59.         //     Open a resources file by name.
  60.         //     This instance assumes responsibility for closing the file.
  61.         
  62.     FW_PResourceFile(Environment* ev, FW_ResourceFileID resFileID);
  63.         // Attach to an already opened resource file.
  64.         // This instance does not assume responsibility for closing the file.
  65.  
  66.     virtual ~FW_PResourceFile();
  67.  
  68.     FW_PResourceFile(const FW_PResourceFile& other);
  69.         // Copy constructor, attach to same file as other.
  70.     
  71.     void operator=(const FW_PResourceFile& other);
  72.         // Assignment operator.
  73.  
  74. protected:
  75.     FW_PResourceFile();
  76. };
  77.  
  78.  
  79. //----------------------------------------------------------------------------------------
  80. // FW_PResourceFile::operator=
  81. //----------------------------------------------------------------------------------------
  82. inline void FW_PResourceFile::operator=(const FW_PResourceFile& other)
  83. {
  84.     FW_TCountedSOMPtr<FW_OResourceFile>::operator=(other);
  85. }
  86.  
  87.  
  88.  
  89. #if defined FW_BUILD_MAC
  90. //========================================================================================
  91. // CLASS FW_CMacResLoadFalse
  92. //========================================================================================
  93. // This utility class provides a mechanism to ::SetResLoad(false) and then be
  94. // assured that ::SetResLoad(true) is executed even in the presend of an FW_THROW
  95.  
  96. class FW_CMacResLoadFalse
  97. {
  98. public:
  99.     FW_DECLARE_AUTO(FW_CMacResLoadFalse)
  100.  
  101.     FW_CMacResLoadFalse();
  102.         // Sets ResLoad false
  103.  
  104.     ~FW_CMacResLoadFalse();
  105.         // Sets ResLoad true
  106. };
  107. #endif
  108.  
  109. #endif
  110.